Integration
Integration Documentation: SOAP API, AJAX & Puppeteer Bot this document details the integration process for updating patient profiles using a combination of SOAP API, AJAX, and a Puppeteer bot. The SOAP API is responsible for updating most fields, while the Puppeteer bot updates the remaining fields using AJAX for form field filling and submission. The profile update process consists of three tabs
- Profile Tab
- Contact Information Tab
- Additional Information Tab
Update Mechanism
SOAP API
The SOAP API is responsible for updating key patient details by making structured requests. The API interacts with the backend system to update information programmatically.
Puppeteer Bot with AJAX
The Puppeteer bot is used to automate the web interface and update fields that are not accessible through the API. This is necessary for fields that require UI interactions, such as dropdown selections, checkboxes, and dynamically populated fields. The bot uses AJAX requests to fill and submit form fields efficiently.
Field Update Responsibilities
-
Profile Tab
| Field Name | Updated By |
|---|---|
First Name | SOAP API |
Last Name | SOAP API |
Middle Name | SOAP API |
Date of Birth | SOAP API |
Phone Number | SOAP API |
Phone Type | Puppeteer Bot |
Email | SOAP API |
Address Line 1 | SOAP API |
Address Line 2 | SOAP API |
Gender Identity | SOAP API |
State | Puppeteer Bot |
City | SOAP API |
Sex | SOAP API |
Zip | SOAP API |
-
Contact Tab
| Field Name | Updated By |
|---|---|
Emergency Contact First Name | SOAP API |
Emergency Contact Last Name | SOAP API |
Emergency Contact Middle Name | SOAP API |
Emergency Contact Phone Number | SOAP API |
Emergency Contact Phone Type | Puppeteer Bot |
Emergency Contact Email Address | SOAP API |
Relationship to Contact | Puppeteer Bot |
Responsible Party First Name | SOAP API |
Responsible Party Last Name | SOAP API |
Responsible Party Middle Name | SOAP API |
Responsible Party Phone Number | SOAP API |
Responsible Party Phone Type | SOAP API |
Responsible Party Email Address | SOAP API |
Relationship to Responsible Party | Puppeteer Bot |
Address Line 1 | SOAP API |
Address Line 2 | SOAP API |
Zip Code | Puppeteer Bot |
-
Additional Information Tab
| Field Name | Updated By |
|---|---|
Race | Puppeteer Bot |
Language | Puppeteer Bot |
Ethnicity | Puppeteer Bot |
Patient Ethnicity Group | Puppeteer Bot |
Patient Race Category | Puppeteer Bot |